Add windows installation; move installation in README to tutorial#122
Add windows installation; move installation in README to tutorial#122mabelzhang wants to merge 2 commits intoign-msgs6from
Conversation
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
mabelzhang
changed the title
Codecov Report
@@ Coverage Diff @@
## ign-msgs6 #122 +/- ##
==========================================
Coverage 84.59% 84.59%
==========================================
Files 7 7
Lines 818 818
==========================================
Hits 692 692
Misses 126 126 Continue to review full report at Codecov.
|
|
|
||
| ## Windows | ||
|
|
||
| First, follow the [ign-cmake](https://github.com/ignitionrobotics/ign-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and creating a Conda environment. |
There was a problem hiding this comment.
Should we point to the tutorial instead?
There was a problem hiding this comment.
So... ign-cmake doesn't currently have any tutorials deployed. It was recently added to deploy them, but those pages don't exist yet. I could link to the source of the tutorial, like https://github.com/ignitionrobotics/ign-cmake/blob/ign-cmake2/tutorials/install.md .
Either way, the URL is version-specific, e.g. ign-cmake2, and that means someone will have to update all the tutorials (this wording is the same for each ignition library's tutorial) for each new release. It would also be a different link depending on whether they want ign-cmake2, or ign-cmake3, etc. So I just opted to give the generic link and let them find the right version to look for the tutorial.
caguero
left a comment
caguero
left a comment
There was a problem hiding this comment.
Just a minor comment, other than that, it looks good to me.
|
Closing in favor of #126 for Citadel |
4 participants
Partially addresses gazebosim/docs#117 and gazebosim/docs#14 (comment) .
TODO: The installation URL in README currently links to
ign-msgstutorials main page, since the installation tutorial webpage doesn't exist yet. Somebody should change the link after this PR is deployed. Trivial fix.